/*
 * Copyright (c) 2006, Second Life Reverse Engineering Team
 * All rights reserved.
 *
 * - Redistribution and use in source and binary forms, with or without 
 *   modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 * - Neither the name of the Second Life Reverse Engineering Team nor the names 
 *   of its contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE 
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 * POSSIBILITY OF SUCH DAMAGE.
 */

using System;
using System.Collections.Generic;

using slcl;
using slcl.Packets;
          
namespace slcl.AssetSystem
{
	/// <summary>
	/// Helper functions for packets relating to images.
	/// </summary>
    public class ImagePacketHelpers
	{
        private Client Client;
        private Grid Grid;

        public ImagePacketHelpers(Client client)
		{
            this.Client   = client;
            this.Grid = Client.Grid;
		}


        /// <summary>
        /// Send a packet requesting an image.  This will either fail silently, or result in 
        /// one ImageData packet, along with zero or more ImagePacket packets.
        /// </summary>
        /// <param name="imageID">LLUUID of the AssetID of an image.</param>
        public Packet RequestImage(LLUUID imageID)
		{
            RequestImagePacket p = new RequestImagePacket();
            p.RequestImage    = new RequestImagePacket.RequestImageBlock[1];
            p.RequestImage[0] = new RequestImagePacket.RequestImageBlock();
            p.RequestImage[0].DownloadPriority = (float)1215000.0;
            p.RequestImage[0].DiscardLevel     = (int)0;
            p.RequestImage[0].Packet           = (uint)0;
            p.RequestImage[0].Image            = imageID;

            //FIXME: Find out what the appropriate values are here.
            p.RequestImage[0].Type             = 0;

            p.AgentData.AgentID   = Grid.AgentID;
            p.AgentData.SessionID = Grid.SessionID;

            return p;
		}

	}
}
